home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il / ilVkComponent.z / ilVkComponent
Encoding:
Text File  |  2002-10-03  |  10.2 KB  |  265 lines
  1.  
  2.  
  3.  
  4. iiiillllVVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllVVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllVVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt - base class for IL ViewKit components
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      VkComponent
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilVkComponent.h>
  16.  
  17. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      This is the base class for IL ViewKit components. It is derived from
  19.      VkComponent and is intended to be used to derive new IL components.
  20.      Member functions are provided to get and set the ilImage represented by
  21.      the component. The virtual member function ilUpdateWidget() is called
  22.      from setImage() to update the the widgets within the component when the
  23.      image changes. Derived classes define ilUpdateWidget().
  24.  
  25. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  26.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  27.  
  28.            ilVkComponent(const char *name)  _p_r_o_t_e_c_t_e_d
  29.            ilVkComponent()                  _p_r_o_t_e_c_t_e_d
  30.  
  31.      GGGGeeeetttt////sssseeeetttt iiiinnnnppppuuuutttt mmmmeeeetttthhhhooooddddssss
  32.  
  33.           virtual void  show()
  34.           virtual void  hide()
  35.           virtual void  realize()
  36.           virtual const char * className()
  37.           virtual void  create(Widget)
  38.           virtual Boolean  okToQuit()
  39.           virtual void  setAttribute(const char *s, void *v)
  40.           virtual char ** attributeList()
  41.           virtual void  getAttribute(const char *s, void **v)
  42.           void      setImage(ilImage* image)
  43.           void      setImage(const char* filename)
  44.           ilImage*  getImage()
  45.           void    setParent(VkComponent* parent)
  46.           void    setParent(Widget parent)
  47.           Widget  getParent()
  48.           virtual void  widgetDestroyed()   _p_r_o_t_e_c_t_e_d
  49.           virtual void  afterRealizeHook()  _p_r_o_t_e_c_t_e_d
  50.           virtual void  ilUpdateWidget()    _p_r_o_t_e_c_t_e_d
  51.  
  52.  
  53. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  54.      iiiillllVVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt(((())))
  55.  
  56.            ilVkComponent()                  _p_r_o_t_e_c_t_e_d
  57.            ilVkComponent(const char *name)  _p_r_o_t_e_c_t_e_d
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllVVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllVVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt((((3333))))
  71.  
  72.  
  73.  
  74.           Both versons of the contructor are protected and can only be used to
  75.           initialize the base class from a derived class's constructor.
  76.  
  77.      aaaafffftttteeeerrrrRRRReeeeaaaalllliiiizzzzeeeeHHHHooooooookkkk(((())))
  78.  
  79.           virtual void  afterRealizeHook()  _p_r_o_t_e_c_t_e_d
  80.  
  81.  
  82.           This method is inherited from VkComponent. See VkComponent for more
  83.           detailed information.
  84.  
  85.      aaaattttttttrrrriiiibbbbuuuutttteeeeLLLLiiiisssstttt(((())))
  86.  
  87.           virtual char ** attributeList()
  88.  
  89.  
  90.           This method is inherited from VkComponent. See VkComponent for more
  91.           detailed information.
  92.  
  93.      ccccllllaaaassssssssNNNNaaaammmmeeee(((())))
  94.  
  95.           virtual const char * className()
  96.  
  97.  
  98.           This method is inherited from VkComponent. See VkComponent for more
  99.           detailed information.
  100.  
  101.      ccccrrrreeeeaaaatttteeee(((())))
  102.  
  103.           virtual void  create(Widget)
  104.  
  105.  
  106.           This method is inherited from VkComponent. See VkComponent for more
  107.           detailed information.
  108.  
  109.      ggggeeeettttAAAAttttttttrrrriiiibbbbuuuutttteeee(((())))
  110.  
  111.           virtual void  getAttribute(const char *s, void **v)
  112.  
  113.  
  114.           This method is inherited from VkComponent. See VkComponent for more
  115.           detailed information.
  116.  
  117.      ggggeeeettttIIIImmmmaaaaggggeeee(((())))
  118.  
  119.           ilImage*  getImage()
  120.  
  121.  
  122.           This method returns the pointer to the ilImage represented by this
  123.           component. See also sssseeeettttIIIImmmmaaaaggggeeee().
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllVVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllVVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt((((3333))))
  137.  
  138.  
  139.  
  140.      ggggeeeettttPPPPaaaarrrreeeennnntttt(((())))
  141.  
  142.           Widget  getParent()
  143.  
  144.  
  145.           This method is inherited from VkComponent. See VkComponent for more
  146.           detailed information.
  147.  
  148.      hhhhiiiiddddeeee(((())))
  149.  
  150.           virtual void  hide()
  151.  
  152.  
  153.           This method is inherited from VkComponent. See VkComponent for more
  154.           detailed information.
  155.  
  156.      iiiillllUUUUppppddddaaaatttteeeeWWWWiiiiddddggggeeeetttt(((())))
  157.  
  158.           virtual void  ilUpdateWidget()    _p_r_o_t_e_c_t_e_d
  159.  
  160.  
  161.           This vitural member function is called by sssseeeettttIIIImmmmaaaaggggeeee() so that the
  162.           widgets in the component can be updated. The current ilImage can be
  163.           accessed using ggggeeeettttIIIImmmmaaaaggggeeee(). For example, a component that displays
  164.           the size of an image would need to get the new image size in order
  165.           to update itself.  Derived classes must define this member function
  166.           to update the widgets it contains.
  167.  
  168.      ooookkkkTTTTooooQQQQuuuuiiiitttt(((())))
  169.  
  170.           virtual Boolean  okToQuit()
  171.  
  172.  
  173.           This method is inherited from VkComponent. See VkComponent for more
  174.           detailed information.
  175.  
  176.      rrrreeeeaaaalllliiiizzzzeeee(((())))
  177.  
  178.           virtual void  realize()
  179.  
  180.  
  181.           This method is inherited from VkComponent. See VkComponent for more
  182.           detailed information.
  183.  
  184.      sssseeeettttAAAAttttttttrrrriiiibbbbuuuutttteeee(((())))
  185.  
  186.           virtual void  setAttribute(const char *s, void *v)
  187.  
  188.  
  189.           This method is inherited from VkComponent. See VkComponent for more
  190.           detailed information.
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. iiiillllVVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt((((3333))))   IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll   iiiillllVVVVkkkkCCCCoooommmmppppoooonnnneeeennnntttt((((3333))))
  203.  
  204.  
  205.  
  206.      sssseeeettttIIIImmmmaaaaggggeeee(((())))
  207.  
  208.           void      setImage(ilImage* image)
  209.           void      setImage(char* filename)
  210.  
  211.  
  212.           These methods sets the ilImage pointer; either to a passed in
  213.           ilImage, or (in the second version) to an ilFileImg constructed by
  214.           opening the file with the specified pathname. After the new image
  215.           pointer has been set, the virtual method iiiillllUUUUppppddddaaaatttteeeeWWWWiiiiddddggggeeeetttt() is called
  216.           to update the widgets contained in the component.
  217.  
  218.      sssseeeettttPPPPaaaarrrreeeennnntttt(((())))
  219.  
  220.           void    setParent(VkComponent* parent)
  221.  
  222.  
  223.           This method is inherited from VkComponent. See VkComponent for more
  224.           detailed information.
  225.  
  226.      sssseeeettttPPPPaaaarrrreeeennnntttt(((())))
  227.  
  228.           void    setParent(Widget parent)
  229.  
  230.  
  231.           This method is inherited from VkComponent. See VkComponent for more
  232.           detailed information.
  233.  
  234.      sssshhhhoooowwww(((())))
  235.  
  236.           virtual void  show()
  237.  
  238.  
  239.           This method is inherited from VkComponent. See VkComponent for more
  240.           detailed information.
  241.  
  242.      wwwwiiiiddddggggeeeettttDDDDeeeessssttttrrrrooooyyyyeeeedddd(((())))
  243.  
  244.           virtual void  widgetDestroyed()   _p_r_o_t_e_c_t_e_d
  245.  
  246.  
  247.           This method is inherited from VkComponent. See VkComponent for more
  248.           detailed information.
  249.  
  250. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  251.      VkComponent
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.